home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / edit / e4dv200.zip / E4README.TXT < prev    next >
Text File  |  1993-06-16  |  23KB  |  580 lines

  1. ****************************************************************
  2. E4(tm) Editor (C) Copyright N.Faulks 1993. All Rights Reserved.
  3. ****************************************************************
  4. Version 2
  5. ****************************************************************
  6.  
  7. Note that this file is an E4 outline document (as well as a 
  8. printable text file), to view it in outline form, from within 
  9. E4, press ALT-H, then Y for "Yes". Now you can press ALT-H over 
  10. headings or text you would like to open or close.
  11.  
  12. If you want to print this file please note that it contains TAB 
  13. characters. To convert it to a printable (tab-less) file type 
  14. "E4 E4README.TXT" then press ALT-P for print, type a filename 
  15. and press RETURN. (or press RETURN to print straight to PRN). To 
  16. leave E4 press ALT-Q.
  17.  
  18. INTRODUCTION ***************************************************
  19.  
  20.  E4 is a powerful multi-file text editor with outlining, 
  21.  macros, SVGA support, and in-editor compilation and 
  22.  error tracking.
  23.  
  24.  E4 isn't a bloated every-feature-under-the-sun product, 
  25.  rather it is a small, fast editor that manages to 
  26.  provide most of the features most people use.
  27.  
  28.  E4 is great for people who only want to edit 
  29.  AUTOEXEC.BAT and CONFIG.SYS as well as Programmers and 
  30.  System/Network Adminstrators.
  31.  
  32.  E4 is a complete Program Development Environment. You 
  33.  can compile from within the editor, a single file or a 
  34.  whole project. You can also run your program from within 
  35.  the editor, with or without a debugger. E4 can shrink in 
  36.  size to only 2K, leaving plenty of memory free for your 
  37.  program. The registered version of E4 comes with a 
  38.  program to trap error messages from a wide range of 
  39.  compilers. You can then step through compilation errors 
  40.  one by one, the cursor is taken to the erroneous line 
  41.  and the error message is displayed at the bottom of the 
  42.  screen. This works across different source files and for 
  43.  most languages (mixed languages are supported), even 
  44.  some linker errors are tracked to the original source 
  45.  file. E4 provides a common development environment, 
  46.  which ever language you are using.
  47.  
  48.  E4 really is better than other editors, because it is 
  49.  easy to use and powerful. Yes, you have to take the 
  50.  trouble to learn it, but once you have got over the 
  51.  short initial learning curve it WILL make you more 
  52.  productive. Easy to use doesn't have to mean pull down 
  53.  menus and WIMPs. E4 works well with a mouse, but the 
  54.  common commands are only a single mnemonic keystroke (E4 
  55.  doesn't use the function keys: how can they be easy to 
  56.  remember?). It doesn't matter if you have "every 
  57.  feature" if they are all equally difficult to use. E4 
  58.  makes everyone into an expert: the "Hintline" shows you 
  59.  most of the commands or options available, at every 
  60.  point in the editor. Full context-sensitive help makes 
  61.  E4 easy to learn.
  62.  
  63.  Feature lists are not the whole story: that's why E4 is 
  64.  made available on a try-before-you buy basis. Don't just 
  65.  reject it because it isn't exactly the same as what 
  66.  you're using: try it!
  67.  
  68.  E4 already has a large user community including 
  69.  professional programmers, businesspeople, educators, and 
  70.  students. If you've got a suggestion or problem call the 
  71.  author (Neil Faulks) on 071 873 2007 (+44 71 873 2007) 
  72.  during office hours, or mail him on the Internet 
  73.  (neil@dcs.kcl.ac.uk) or through CompuServe 
  74.  (>INTERNET:neil@dcs.kcl.ac.uk). We want you to be happy 
  75.  with E4, before and after you buy it.
  76.  
  77. E4-DELUXE ******************************************************
  78.  
  79.  There are two varieties of E4: E4 and E4-Deluxe. The 
  80.  original E4 is distributed as the file E4???.ZIP, where 
  81.  ??? is the version number. E4-Deluxe is distributed as 
  82.  E4D???.ZIP If you register E4 or E4-Deluxe you get both 
  83.  versions for the one price.
  84.  
  85.  E4-Deluxe is a larger version of E4 that provides 
  86.  pull-down menus. These menus are fully user-definable 
  87.  and can be made CUA compliant.
  88.  
  89.  E4-Deluxe comes with keyboard and menu files that allow 
  90.  E4 & E4-Deluxe to emulate a number of popular editors 
  91.  and word-processors. Obviously E4-Deluxe is required to 
  92.  emulate the menus of an application, but the keyboard 
  93.  files will also work with standard E4.
  94.  
  95.  You can also use a menu file to help you or your users 
  96.  migrate from another editor to E4. In this case E4 
  97.  simulates the menus of the other editor, but displays 
  98.  the correct E4 keystrokes. The message line also 
  99.  displays helpful information as you move the selector 
  100.  bar over the menus.
  101.  
  102.  Note that it is not possible to simulate all the 
  103.  features of other editors. Quite often basic differences 
  104.  mean that the E4 method appears cumbersome when looked 
  105.  at from the perspective of a user of another editor. 
  106.  However, E4 is far from cumbersome and you are 
  107.  encouraged to LEARN E4 rather than persisting with your 
  108.  old editing techniques. The E4 user community includes 
  109.  former users of Boxer, QEDIT and Brief and the various 
  110.  Borland IDEs, all of whom have happily switched to using 
  111.  E4. They are happy because E4 makes them more 
  112.  productive.
  113.  
  114.  You can choose an editor to emulate by using the /= 
  115.  command line switch. This selects the keyboard (.E4K) 
  116.  and menu (.E4U) files with the name given following the 
  117.  equals sign. For example
  118.  
  119.      E4 /=CUA
  120.  
  121.  Will run E4 in CUA mode. You can put this option in the 
  122.  E4 environment variable. See "INSTALLATION" below.
  123.  
  124.  The options available are listed below, but you are 
  125.  encouraged to try the native E4 menus and keystrokes 
  126.  before using these.
  127.  
  128.  BC    Borland C/Turbo Pascal IDE keystrokes only
  129.  CUA    Very simple CUA menus and some CUA keystrokes.
  130.  BOXERM    Boxer menus, E4 keystrokes, with tutorial information
  131.  QEDIT    full QEDIT simulation, menus and keyboard
  132.  QEDITM    QEDIT menus, E4 keystrokes, with tutorial information
  133.  WP    Wordperfect Function keys (& ^INS and ^DEL), no menus.
  134.  WS    WordStar control keys.
  135.  
  136.  All trademarks are acknowledged.
  137.  
  138.  Extra items in the E4 Deluxe Distribution include:
  139.  
  140.  E4.EXE        E4-Deluxe instead of E4
  141.  
  142.  *.E4K        Keymap files (like E4KEYS)
  143.  *.E4U        Menu files
  144.  
  145.  To use a keymap and/or menu file run the editor using 
  146.  the /= switch.
  147.  
  148.  Note that the menu bar will not appear unless at least 
  149.  one keystroke in the keymap file is assigned to the 
  150.  special keyname "menu".
  151.  
  152. IMPORTANT NOTICE ***********************************************
  153.  
  154.  This is a Try-before-you-buy Evaluation copy of the E4 
  155.  Editor, it is fully functional. You may use E4 freely 
  156.  for up to 30 days, but if you want to use it after this 
  157.  period you must pay for it. See later in this file.
  158.  
  159.  Occasionally the editor will ask you to press a key when 
  160.  you first run it, this feature is absent from the 
  161.  version you will receive upon payment.
  162.  
  163.  Buying your own copy also brings the benefits of 
  164.  comprehensive printed documentation, extra utility 
  165.  programs and macros, and special offers on upgrades and 
  166.  other products.
  167.  
  168.  Programmers should note that only the registered version 
  169.  supports compiler error message tracking, as it requires 
  170.  extra support programs.
  171.  
  172. PACKING LIST & RELEASE NOTES ***********************************
  173.  
  174.  This software should be distributed as the single .ZIP 
  175.  or .EXE archive. The archive file contains the files 
  176.  listed below (for extra files included with E4-Deluxe 
  177.  see above). PLEASE KEEP THE ORIGINAL ARCHIVE FILE TO 
  178.  GIVE TO OTHERS.
  179.  
  180.  E4.EXE        The Editor itself (All you really need!)
  181.  E4.HLP        The help file for the editor 
  182.  E4KEYS        A sample keyboard mapping file 
  183.  E4README.TXT    This document, Please read it all 
  184.  E4ORDER.TXT    Printable order form and prices 
  185.  VENDOR.TXT    Notes for shareware vendors and BBSs. 
  186.          Includes feature lists and descriptions 
  187.  FILE_ID.DIZ    A BBS description file 
  188.  TEMPLATE.C    Sample template file for C programs 
  189.  E4OPTS.C    Sample options file for C programs
  190.  COMPILE.EXE    A generic compiler control program
  191.  COMPILE.DOC    Documentation for COMPILE
  192.  COMPILE.CL    Configuration file for COMPILE
  193.  
  194.  The sample E4KEYS file includes some key definitions of 
  195.  use only to programmers, to handle in-editor 
  196.  compilation. These are distributed as macros in the 
  197.  registered version, but are included here in the keys 
  198.  file to save space. The sample definitions allow you to 
  199.  compile from within the editor (a single file or a 
  200.  complete project), and to execute your program with or 
  201.  without a debugger. The registered version provides full 
  202.  error tracking, allowing you to step through error 
  203.  messages one by one, taking you to the correct file and 
  204.  line. 
  205.  
  206.  Programmers should examine the E4KEYS file to learn 
  207.  about creating macros to compile and debug programs. 
  208.  
  209. CHANGES ********************************************************
  210.  
  211.  Only major changes are listed, numerous minor changes 
  212.  are made with every release. The registered version has 
  213.  more detailed information.
  214.  
  215.  Version 2.0
  216.   
  217.   Rectangular Box Marking. Command line selectable 
  218.   keymaps. Paste chars from ASCII chart. Select 
  219.   video rows from command line. 2-Key assignments. 
  220.   View control chars as symbols or letters. 
  221.   Enhanced exploding macros. Enhanced marking 
  222.   mode, menu and display, with measurement 
  223.   capability. Roaming Cursor (RC) mode to allow 
  224.   cursor to move freely around screen. Shift 
  225.   marking on more keys.
  226.   
  227.  Version 1.6
  228.   
  229.   Outlining. XMS swapping (leaving <2K resident). 
  230.   Colour Brackets. LOOP, ENDLOOP and STOP in 
  231.   macros. Support for Read-only buffers 
  232.   (independent of Read-only files).
  233.   
  234.  Version 1.51
  235.   
  236.   New Ditto function using ALT-Space Bar. New 
  237.   CATCH macro keyword (useful in template macros). 
  238.   Enhanced handling of Read-Only files, can now 
  239.   edit System and Hidden files also. Enhanced 
  240.   handling of environment variables in DOS 
  241.   commands. Better handling of ^Break when macro 
  242.   playing is paused. Modified screen blanker to 
  243.   allow portables to power down.
  244.   
  245.  Version 1.5
  246.   
  247.   Support for external commands and tools. All new 
  248.   Picture mode/Line Draw mode. Automatic Project 
  249.   File creation. New commands: Buffer Reload, 
  250.   Tools Editclip, Goto Edit (New edit tracking 
  251.   system). Multiple tags. New Wordprocessing and 
  252.   WordWrap modes. Support for bright screen 
  253.   background colours. More support for Novell 
  254.   Netware. Template Macros. Enhanced Find Eol to 
  255.   allow searching for Lone CR or LF at ends of 
  256.   lines. Extended help system.
  257.   
  258.  Version 1.0
  259.   
  260.   First non-commercial release.
  261.  
  262. OVERVIEW *******************************************************
  263.  
  264.  E4 will run on any PC compatible with 128K of RAM, under 
  265.  MSDOS 3.0 or above, and any standard display adaptor. A 
  266.  hard disk is not required: the minimum installation is 
  267.  about 40 (42K for E4-Deluxe).
  268.  
  269.  SVGA support allows for special text modes such as 
  270.  100x40, 100x75 and 132x60, on those cards that offer it, 
  271.  up to 255x255.
  272.  
  273.  Full use is made of enhanced keyboards including F11 & 
  274.  F12 and other special key combinations. Full mouse 
  275.  support (for a true Microsoft compatible mouse) allows 
  276.  on screen selection of text and menu operation. Note 
  277.  that mouse support in SVGA screen modes often does not 
  278.  work due to mouse driver limitations.
  279.  
  280.  The editor occupies little disk space making it suitable 
  281.  for installation on a RAM Disk, the optional help file 
  282.  can be relocated elsewhere; using the E4HELP environment 
  283.  variable. 
  284.  
  285.  E4 has a short start up time and loads and saves files 
  286.  very quickly.
  287.  
  288.  Most of the keys on the keyboard may be redefined to 
  289.  suit you. Any standard key combination, or pair of keys, 
  290.  may be assigned to one or more editor functions, simply 
  291.  by editing a text file listing the assignments to be 
  292.  made (E4KEYS). A command line switch can be used to 
  293.  override customisation so that someone can use the 
  294.  editor on another person's machine, for example when 
  295.  giving help in a school or college.
  296.  
  297.  The normal Cut and Paste system, which allows arbitrary 
  298.  streams of characters to be moved about the editor, is 
  299.  augmented by a simple system for moving and copying 
  300.  whole lines, as this is such a common operation. 
  301.  
  302.  A design limitation is that the maximum file size that 
  303.  may be edited is 64K, and is one reason the editor is so 
  304.  small. This limit is offset somewhat by the ease with 
  305.  which multiple files may be edited. In particular you 
  306.  are able to perform a truly global search and replace 
  307.  operation that affects several files. When programming 
  308.  it is not a good idea to construct a program by using 
  309.  one monolithic file, better to split it up into several 
  310.  modules.
  311.  
  312.  E4 comes with complete context-sensitive on-line help. 
  313.  But you can use page-up and page-down to move through 
  314.  the help screens one by one if you want to make sure you 
  315.  see them all. Press F1 twice to find out how to use 
  316.  help.
  317.  
  318. INSTALLATION & RUNNING *****************************************
  319.  
  320.  DOS 3.0 or above is needed to run E4.
  321.  
  322.  Copy the files listed in the packing list above to a 
  323.  directory on your hard disk and put that directory in 
  324.  your PATH. For example if you create a directory for the 
  325.  editor called C:\E4 then you should add the following 
  326.  line to your AUTOEXEC.BAT file (and reboot):
  327.  
  328.      PATH C:\E4;%PATH%
  329.  
  330.  If you have CED or ANARKEY or a similar command line 
  331.  editor, you can have an alias that expands to the full 
  332.  pathname of the editor, instead of adding the editor 
  333.  directory to the PATH. E4 does not need to be in the 
  334.  path to find its support files or programs.
  335.  
  336.  Run the editor with the list of filenames you wish to 
  337.  edit. Wildcards may be included:
  338.  
  339.      E4 \AUTOEXEC.BAT \CONFIG.SYS \WINDOWS\*.INI
  340.  
  341.  NOTE: A few systems may not correctly identify the type 
  342.  of keyboard they have: if the editor hangs then reboot, 
  343.  and run it again with the /P switch, which forces it to 
  344.  use only the standard (PC) keyboard driver, rather than 
  345.  the enhanced (AT) driver. Note that the editor has been 
  346.  tested and does work correctly on true IBM PCs, IBM 
  347.  PC/ATs and IBM PS/2s, as well as many machines from a 
  348.  variety of manufacturers including Compaq, Dell, Grid, 
  349.  NEC and Tandon.
  350.  
  351.  The /B command line switch will run the editor in black 
  352.  and white. /? will list other switches.
  353.  
  354.  F1 displays context sensitive help.
  355.  
  356.  Press ALT-Q to leave the editor.
  357.  
  358.  You can put standard switch settings into the E4 
  359.  environment variable:
  360.  
  361.      SET E4=/B
  362.  
  363.  The example above will cause the editor to always run in 
  364.  Black and White.
  365.  
  366.  You can have many options listed in the environment 
  367.  variables. For example, if you also want to use CUA mode 
  368.  you would set the variable like this:
  369.  
  370.      SET E4=/B /=CUA
  371.  
  372.  Configuration files and macro directories are created by 
  373.  default in the current directory. To make the editor 
  374.  place them in the directory containing E4.EXE use the 
  375.  following command:
  376.      
  377.      SET E4PATH=*
  378.  
  379.  These SET statements are best placed in your 
  380.  AUTOEXEC.BAT file.
  381.  
  382. DEMO ***********************************************************
  383.  
  384.  For a short demonstration of Resume Mode go to the root 
  385.  directory of your boot disk and (assuming E4 is in your 
  386.  PATH) type
  387.      
  388.      E4 /R AUTOEXEC.BAT CONFIG.SYS
  389.  
  390.  Then press ALT-Q to quit the editor.
  391.  
  392.  Now whenever you want to edit your configuration simply 
  393.  go to the root directory and type
  394.  
  395.      E4
  396.  
  397.  The cursor will be where it was and the same files will 
  398.  be loaded. Any new files you load will also be available 
  399.  to future sessions.
  400.  
  401. BORLAND PARADOX ************************************************
  402.  
  403.  If you use Borland's Paradox (3.5 or 4.0) you can 
  404.  install E4 as the default editor. Use the following 
  405.  command line:
  406.      
  407.      E4 /XSC * /**
  408.  
  409.  This sets the default extension for loading and saving 
  410.  to .SC (for script). Paradox replaces the * by the 
  411.  filename and the ** by a line number within the file (E4 
  412.  interprets a number after a slash as a line number to go 
  413.  to on start up).
  414.  
  415. SUPPORT ********************************************************
  416.  
  417.  Technical support is available directly from the author 
  418.  by Post or E-Mail to any of the addresses given at the 
  419.  foot of this document. E-mail is preferred.
  420.  
  421.  Support is available whether or not you are a registered 
  422.  user: We want you to be happy with E4 before you buy it.
  423.  
  424. ORDERING and PAYMENT *******************************************
  425.  
  426.  This software has been made available so that potential 
  427.  users may try it out before committing to buy it. If you 
  428.  think that you have already paid for this software then 
  429.  you have been mislead by whoever took your money. Many 
  430.  organisations charge a copying fee for providing 
  431.  evaluation copies of software like this, which is 
  432.  legitimate within the limits detailed in the VENDOR.TXT 
  433.  file. Others, who may also be charging a higher fee, do 
  434.  not make it clear that you are paying them a service 
  435.  charge for providing you with an evaluation copy of the 
  436.  software.
  437.  
  438.  You must pay for this software if you continue to use 
  439.  it. This is copyrighted commercial software. The term 
  440.  "Shareware" is often applied to software marketed in 
  441.  this way, but it must not be confused with free software 
  442.  such as that in the Public Domain (PD).
  443.  
  444.  To pay for this software please examine the file 
  445.  E4ORDER.TXT, which is a registration and order form. You 
  446.  can fill this in before or after printing it out. 
  447.  Alternatively any form of order may be used provided 
  448.  that all the information requested in the text file is 
  449.  provided. Always quote the issue number given on that 
  450.  form (the same Issue Number appears in the editor banner 
  451.  screen).
  452.  
  453.  In exchange for payment you will receive a version of 
  454.  the software without the registration reminders, and 
  455.  which is registered to you personally. The price 
  456.  includes both E4 and E4-Deluxe, a comprehensive printed 
  457.  manual and extra utility programs and macros.
  458.  
  459.  Note that this registered version may not be distributed 
  460.  in any way and must be treated like any other commercial 
  461.  program. Please refer to the licence agreements below.
  462.  
  463. EXTRAS *********************************************************
  464.  
  465.  The following extra programs (at least) are shipped with 
  466.  the commercial version of the editor:
  467.  
  468.  E4SM    a program to set special text modes on VGA/EGA 
  469.      cards. It also analyses your VGA card to find 
  470.      out what special text modes are available.
  471.  
  472.  E4TRAP    a program to trap error output from a range of 
  473.      compilers so that E4 can perform error tracking. 
  474.      Currently supported compilers include Borland 
  475.      C/C++, Turbo Pascal, Turbo Linker, Turbo 
  476.      Assembler, Microsoft C, MASM, Fitted Software 
  477.      Modula-2, Zortech C/C++ and others. Other 
  478.      compilers will be added in the future.
  479.      
  480.      Many compilers that are not listed will also 
  481.      work, if they generate standard error messages. 
  482.      Contact us if your compiler is not listed, we 
  483.      will add it if necessary.
  484.  
  485.  E4PRINT    a program to print E4 wordwrap files (and 
  486.      ordinary text files) on normal and PostScript 
  487.      printers.
  488.  
  489.  A library of useful programmer's macros is also 
  490.  provided.
  491.  
  492. LICENCE AGREEMENTS *********************************************
  493.  
  494.  "The software" refers in this case to the E4 editor and 
  495.  any associated documentation and/or additional programs 
  496.  or other items.
  497.  
  498.  "The purchaser" is that person or organisation that pays 
  499.  the fee for the software.
  500.  
  501. Licence for the Unregistered Version (this version) ************
  502.  
  503.  This software is copyrighted and any duplication other 
  504.  than under the terms of this agreement is a breach of 
  505.  copyright law. You are given permission to duplicate the 
  506.  software to give to others provided that you do not make 
  507.  any changes to the software and that you distribute it 
  508.  complete (preferably as the single self-extracting 
  509.  archive file described above). You must not make a 
  510.  charge for providing a copy of the software other than 
  511.  within the limits detailed in the VENDOR.TXT file.
  512.  
  513.  You are permitted to use the editor for a period not 
  514.  exceeding 30 days beginning from the date of first use. 
  515.  After this time you must pay if you wish to continue 
  516.  using it, even if you intend to do so only infrequently. 
  517.  If you do not purchase your own copy then you should 
  518.  keep the software only in its archived (unusable) form 
  519.  for the purposes of giving it to others.
  520.  
  521. Licences for the Commercial Version ****************************
  522.  
  523.  This software is copyrighted and any duplication other 
  524.  than under the terms of this agreement is a breach of 
  525.  copyright law. 
  526.  
  527.  Payment of the registration fee gains for the purchaser 
  528.  one or more disks and a licence to use the software 
  529.  contained on those disks subject to the conditions 
  530.  detailed below. 
  531.  
  532.  Single user Licence ************************************
  533.   
  534.   The software provided upon payment of the 
  535.   registration fee may not be duplicated other 
  536.   than for the purposes of installing it on one or 
  537.   more computers owned by the purchaser of the 
  538.   software, and/or for a single "back-up" copy of 
  539.   the supplied original disk or disks. The 
  540.   purchaser may install the software on more than 
  541.   one computer provided that there is no 
  542.   possibility that more than a single copy of the 
  543.   software be in use at any instant.
  544.   
  545.  Network Licence ****************************************
  546.   
  547.   Purchase of a network licence allows you to 
  548.   install the software on a single file server 
  549.   only (NOT a node in a peer-to-peer network). The 
  550.   software may be used only by machines attached 
  551.   to that network that are using that server. The 
  552.   software may not be installed on any other 
  553.   computer.
  554.   
  555.   You must take all reasonable precautions to 
  556.   prevent unauthorised copying. For example, for a 
  557.   Novell network you must set the Execute Only 
  558.   attribute for all executables that form part of 
  559.   the software.
  560.  
  561. AFTERWORD and ADDRESSES ****************************************
  562.  
  563.  Thank you for taking the time to wade through this file. 
  564.  Please try out the program and send me your comments, 
  565.  even if you choose not to continue using E4!
  566.  
  567.  Author:            UK Distributors:
  568.  Neil Faulks        Business Consultants Ltd.
  569.  28 Clickett Hill    37 York Road
  570.  Basildon        Woking
  571.  Essex            Surrey
  572.  England            England
  573.  SS14 1NW        GU22 7XN
  574.  
  575.  E-mail:        neil@dcs.kcl.ac.uk
  576.  CompuServe:    >INTERNET:neil@dcs.kcl.ac.uk
  577.  
  578.  
  579. End-of-File
  580.